<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilpki: xilpki.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilpki
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xilpki_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xilpki.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><pre></pre><pre> This file contains the implementation of the interface functions for the
 PKI ECDSA hardware module.
 MODIFICATION HISTORY:</pre><pre> Ver   Who   Date      Changes
 ----- ----  --------  ------------------------------------------------------
 1.0   Nava  12/05/22  Initial Release
 1.1   Nava  06/06/23  Fix the issues relevant to the pki mux selection/deselection
                       logic.
 2.0   Nava  06/21/23  Added PKI multi-queue support for ECC operations.
 2.0   Nava  08/02/23  Added a new API XPki_GetVersion() to access the library
                       version info.
 2.0   Nava  09/06/23  Updated the XPki_GetVersion() API prototype to inline with
                       other secure library version info API's.
 2.0   Nava  09/07/23  Fixed issues with IRQ signal.
 2.0   Nava  09/11/23  Fixed doxygen warnings.
 2.1   Nava  12/07/23  Corrected the PKI_ECC_NIST_P384_KEY_PRIV_GEN_CMD value.
 2.1   Nava  12/27/23  Updated the XPki_DeQueueData() API to return the proper error
                       status for CopyEcdsa* operations.
 2.1   Nava  01/03/24  Fixed security issues relevant to instance pointer NULL check.
 2.2   kpt   01/09/24  Updated option for non-blocking trng reseed
 2.2   Nava  06/12/24  Added support for system device-tree flow.</pre><pre></pre><dl class="section note"><dt>Note</dt><dd></dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga505935a763918d9c3703d7b27be9a41b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#ga505935a763918d9c3703d7b27be9a41b">XPki_Reset</a> (void)</td></tr>
<tr class="memdesc:ga505935a763918d9c3703d7b27be9a41b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reset the PKI module.  <a href="group__xilpki-api.html#ga505935a763918d9c3703d7b27be9a41b">More...</a><br/></td></tr>
<tr class="separator:ga505935a763918d9c3703d7b27be9a41b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ea0ba13f75d8fef10d836964638a016"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#ga9ea0ba13f75d8fef10d836964638a016">XPki_SoftReset</a> (void)</td></tr>
<tr class="memdesc:ga9ea0ba13f75d8fef10d836964638a016"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs the PKI module soft reset.  <a href="group__xilpki-api.html#ga9ea0ba13f75d8fef10d836964638a016">More...</a><br/></td></tr>
<tr class="separator:ga9ea0ba13f75d8fef10d836964638a016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga576bdd3a3c4387f79ce64072c9be1e8e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#ga576bdd3a3c4387f79ce64072c9be1e8e">XPki_Initialize</a> (XPki_Instance *InstancePtr)</td></tr>
<tr class="memdesc:ga576bdd3a3c4387f79ce64072c9be1e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs the PKI module initialization.  <a href="group__xilpki-api.html#ga576bdd3a3c4387f79ce64072c9be1e8e">More...</a><br/></td></tr>
<tr class="separator:ga576bdd3a3c4387f79ce64072c9be1e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ddb8e612b2e3b756bfbff5ba1d81bb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#ga2ddb8e612b2e3b756bfbff5ba1d81bb8">XPki_Close</a> (void)</td></tr>
<tr class="memdesc:ga2ddb8e612b2e3b756bfbff5ba1d81bb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to disable access to the PKI Hardware.  <a href="group__xilpki-api.html#ga2ddb8e612b2e3b756bfbff5ba1d81bb8">More...</a><br/></td></tr>
<tr class="separator:ga2ddb8e612b2e3b756bfbff5ba1d81bb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17c93923bc5348033293e61c582eb7a3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#ga17c93923bc5348033293e61c582eb7a3">XPki_TrngGenerateRandomNum</a> (u8 GenSize, u8 *RandBuf)</td></tr>
<tr class="memdesc:ga17c93923bc5348033293e61c582eb7a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to generate the Random number for the give size.  <a href="group__xilpki-api.html#ga17c93923bc5348033293e61c582eb7a3">More...</a><br/></td></tr>
<tr class="separator:ga17c93923bc5348033293e61c582eb7a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56071d557aca5100f5e0f77f9c49c572"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#ga56071d557aca5100f5e0f77f9c49c572">XilPki_EnQueue</a> (XPki_Instance *InstancePtr, <a class="el" href="struct_x_pki___request___info.html">XPki_Request_Info</a> *Request_InfoPtr, u32 *RequestID)</td></tr>
<tr class="memdesc:ga56071d557aca5100f5e0f77f9c49c572"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to submit the crypto operation to the PKI Queue.  <a href="group__xilpki-api.html#ga56071d557aca5100f5e0f77f9c49c572">More...</a><br/></td></tr>
<tr class="separator:ga56071d557aca5100f5e0f77f9c49c572"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc4bfe87976eaae5bf350315054d9be1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilpki-api.html#gacc4bfe87976eaae5bf350315054d9be1">XilPki_DeQueue</a> (XPki_Instance *InstancePtr, <a class="el" href="struct_x_pki___request___info.html">XPki_Request_Info</a> *Request_InfoPtr, u32 RequestID)</td></tr>
<tr class="memdesc:gacc4bfe87976eaae5bf350315054d9be1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to get the crypto operation results from the PKI Queue.  <a href="group__xilpki-api.html#gacc4bfe87976eaae5bf350315054d9be1">More...</a><br/></td></tr>
<tr class="separator:gacc4bfe87976eaae5bf350315054d9be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
